home *** CD-ROM | disk | FTP | other *** search
/ Atari Mega Archive 2 / Atari Mega Archive CD - Volume 2.iso / minix / up1510b.tgz / up1510b / src / commands / nroff / ex1.nr < prev    next >
Text File  |  1990-07-21  |  4KB  |  97 lines
  1. .\" example 1.     execute with: nroff ex1.nr
  2. .\"
  3. .\" we first set up basic page parameters (left offset, line length,
  4. .\" title length, and where titles and footers go. we define a macro
  5. .\" to handle paragraphs. it just breaks the last line (.sp does this),
  6. .\" spaces down 2 lines, and temprarily indents the next line (.ti).
  7. .\" the .ti has a "+" so this means add to the current indent. then
  8. .\" we center the title and redefine the page header after the first
  9. .\" line of text to keep the page header off the first page. invoke
  10. .\" the paragraph macro (.IP) at every paragraph.
  11. .\"
  12. .pl 66                           \" page length (lines)
  13. .po 5                            \" page offset (left margin)
  14. .ll 65                           \" line length
  15. .lt 65                           \" title length
  16. .m1 3                            \" lines from page top to header
  17. .m2 3                            \" lines from header to text
  18. .m3 3                            \" lines from text to footer
  19. .m4 3                            \" lines from footer to page botton
  20. .fo ||- % -||                    \" page footer (just page number)
  21. .de IP                           \" define a macro
  22. .sp 2                            \" 2 spaces
  23. .ti +5                           \" indent next line 5 spaces
  24. ..                               \" end macro
  25. .ce 6                            \" center next 6 lines
  26. NROFF Report Formatting
  27.  
  28. by
  29.  
  30. Bill Rosenkranz
  31. rosenkra@hall.cray.com
  32. .\"
  33. .\"
  34. .tl ||NROFF Report Formatting||  \" page header (centered)
  35. .IP                              \" invoke our macro
  36. Nroff is a text processor and formatter based on the design
  37. provided in "Software Tools" by Kernighan and Plauger.
  38. It has been modified to closely resemble the Unix(tm) nroff command.
  39. The text and commands found in the file(s) are processed to generate
  40. formatted text.
  41. Note that one (and only one) of the files can be "-"
  42. which reads input from stdin at that point.
  43. The output always goes to stdout which can be redirected by the shell.
  44. The -o option lets you redirect error output to the specified file
  45. rather than stderr.
  46. Debugging information always goes to the file
  47. "nroff.dbg" and is generally used only for program development.
  48. .IP
  49. Nroff recognizes the following environment variables from the shell.
  50. .IP
  51. An alternate directory to find the files tmac.* ("." for example).
  52. The default is c:\\lib\\tmac under TOS and /usr/lib/tmac under
  53. Minix or Unix(tm).
  54. .IP
  55. An alternate directory to place any temporary files.
  56. The default is the current directory.
  57. .IP
  58. Commands typically are distinguished by a period in column
  59. one of the input followed by a two character abbreviation
  60. for the command funtion.
  61. The abbreviation may then be
  62. followed by an optional numeric or character argument.
  63. The numeric argument may be an absolute value such as setting
  64. the right margin to a particular column, or the argument may 
  65. be preceded by a plus sign or a minus sign to indicate that
  66. the parameter should be modified relative to a previous
  67. setting.
  68. The following commands are recognized (those
  69. marked "extension" are requests added to the basic set
  70. provided by Unix(tm) nroff):
  71. .IP
  72. Begin line adjustment.
  73. If fill mode is not on, adjustment is defered until it is back on.
  74. If a type indicator is present, the adjustment type is changed as follows: 
  75. .ne 7           \" need 7 lines without a break
  76. .nf             \" nofill for the table
  77.  
  78. Indicator      Type
  79.    l           adjust left margin only
  80.    r           adjust right margin only
  81.    c           center
  82. b or n         adjust both margins (default)
  83. absent         unchanged
  84. .fi            \" back to fill mode
  85. .IP
  86. Causes the following lines of text to appear in boldface.
  87. The optional argument specifies the number of lines to be typed in boldface.
  88. Boldface and underlining are mutually exclusive features.
  89. The appearance of a boldface command will cause any underlining to cease.
  90. .IP
  91. Causes succeeding text to appear at the top of a new page.
  92. The optional argument specifies the page number for the new page.
  93. The initial value is one and the
  94. default value is one more than the previous page number.
  95. .\"
  96. .\" the end...
  97.